Skip to main content

eSubmission of Warranty

Detailed description of API:

Interface currently available for DMS development in:
  • NAFTA

Version & Updates​

VersionRevision DateRevision History
1.010th Aug 2023New Release
1.111th Apr 2024Updated the Feature name to eSubmission of Warranty. Updated the Defect Failure code API response structure.
1.222nd Aug 2024Updated response codes
1.318th Aug 2024Updated case sensivity, attached claim submission attribute file.

Overview​

There are three sub-functions within the Warranty Claim eSubmission API:

  • Create Warranty Claims:

Used to initiate a claim request in the CNHi eWarranty system in real-time from the DMS application

  • Claims Attachments:

    Used to pass additional attachments (PDF/images) associated with the claim. The same claim number that is generated by the “Create Warranty Claims” is sent as an input to this API. This is currently non mandatory, in future for certain claim types this claim attachment API will be required to send additional documentation

  • Defect Failure Code Lookup:

    Used to search and retrieve the Defect codes and Failure codes needed to complete an eWarranty Claim before submission

image.png

Pre-requisites

  • Dealer must use their Dealer Portal credentials to authorize API call.
  • Each DMS provider will have a subscription_key assigned by CNHi team, please reach out to dlnadmssupport@cnh.com for assistance
  • Each Subscription key is unique to DMS and the environment it belongs to
  • Based on the payload (XML/JSON), user to pass the content-type in the header

Authentication

  • DMS will pass Basic auth in HTTP header with username/password
  • Each DMS provider will have a subscription_key assigned by CNHi team, please reach out to dlnadmssupport@cnh.com for assistance
  • The UserID and Password will be set up in the Dealer Portal by the Dealer uniquely for DMS access to interfaces
  • DEP API will require subscription_key in HTTP header to identify client

API Format​

  • REST
  • SOAP

The DEP takes care of the format transformations (as needed) to process the request and provide a response to the DMS system. REST format is always suggested for greater simplicity.

Connection Details​

CNHi provides two environments:

  • CERT / UAT
  • Production

Create Claim API​

Using the CNHi eSubmission - Create Claim API, DMSs can submit a real-time requests to create a Warranty Claim

EnvironmentURLAPIRequest Type
CERT/UAThttps://{base_url}/external/services/warrantyclaim_esubmission/v1SOAPPOST
https://{base_url}/external/services/warrantyclaim_esubmission/v2RESTPOST
Productionhttps://{base_url}/external/services/warrantyclaim_esubmission/v1SOAPPOST
https://{base_url}/external/services/warrantyclaim_esubmission/v2RESTPOST
Note: All Request Query Parameters are case sensitive.

Warranty Claim eSubmission Attributes​

Download Warranty Claim Submission Attributes

XML Request Body Sample​

Download Create Claim XML Sample Request Body

JSON Request Body Sample​

Download Create Claim XML Sample Request Body

Response Description​

NameTypeDescription
ClaimResponseObjectClaim Response
ClaimResponse.DealerCodeStringDealer Code
ClaimResponse.WorkshopCodeStringWorkshop Code
ClaimResponse.DmsClaimNumberStringDMS Claim Number
ClaimResponse.JobOrderNumberStringJob Order Number
ClaimResponse.ReferenceDateStringReference Date
ClaimResponse.CnhClaimNumberStringCNH Claim Number
ClaimResponse.SerialNumberStringSerial Number
ClaimResponse.VanCodeStringVan Code
ClaimResponse.DealerNameStringDealer Name
ClaimResponse.StatusStringStatus
ClaimResponse.StatusDescriptionStringStatus Description
ClaimResponse.ClaimedValueStringClaimed Value
ClaimResponse.ReimbursedValueStringReimbursed Value
ClaimResponse.CurrencyStringCurrency
ClaimResponse.MessageObjectMessage
ClaimResponse.Message.itemArrayMessage Item
ClaimResponse.Message.item.RowNumberStringRow Number
ClaimResponse.Message.item.RowTextStringRow Description

XML Response Sample​

Download Create Claim XML Response Sample

JSON Response Sample​

Download Create Claim JSON Response Sample

Claim Processing / Attachment API​

This is used to pass additional attachments (PDF/images) associated with the claim. The same claim number that is generated by the Create Claim API is sent as an input to this API.

  • Claim Attachment POST API can upload an attachment (document or image) for submitted claim.
  • Claim Attachment GET API can retrieve the same attachment using required parameters (like attname, atttype and objkey).
EnvironmentURLAPIRequest Type
CERT/UAThttps://{base_url}/external/services/warrantyclaim_esubmission/v2/claimattachmentRESTPOST
https://{base_url}/external/services/warrantyclaim_esubmission/v2/claimattachmentRESTGET
Productionhttps://{base_url}/external/services/warrantyclaim_esubmission/v2/claimattachmentRESTPOST
https://{base_url}/external/services/warrantyclaim_esubmission/v2/claimattachmentRESTGET

Request Description​

Note: All Request Query Parameters are case sensitive.
NameParams TypeTypeIs RequiredComments
attnameQuerystringfalseName of the attachment
sap-clientQuerystringfalseSap-Client (fixed value "602")
atttypeQuerystringfalseMedia Type (jpeg or pdf)
objkeyQuerystringfalseCNH Claim number

Request Body​

MethodNameTypeDescription
POSTRequest Body"Image/jpeg" or “application/pdf"Required attachment should be uploaded as image or document in the request body. It can be "image/jpeg" for an image, "application/pdf" for a pdf document.
GETRequest BodyRequest body not required

Response Description​

    {
    "statuscode": "200",
    "message": "Claim Processing Completed."   
    }
Status CodeMessage
200"Claim Processing Completed."

Sample PDF Claim Attachment Request​

Download Claim Attachment PDF Sample

Sample JPEG Claim Attachment Request​

Download Claim Attachment JPEG Sample

Defect Failure Code API​

This is used to search and retrieve the Defect and Failure codes needed to complete an eWarranty Claim before submission.

EnvironmentURLAPIRequest Type
CERT/UAThttps://{base_url}/external/services/warrantyclaim_esubmission/v1/defectfailureSOAPPOST
https://{base_url}/external/services/warrantyclaim_esubmission/v2/defectfailureRESTPOST
Productionhttps://{base_url}/external/services/warrantyclaim_esubmission/v1/defectfailureSOAPPOST
https://{base_url}/external/services/warrantyclaim_esubmission/v2/defectfailureRESTPOST
Note: All Request Query Parameters are case sensitive.

XML Request Body Sample​

Download Defect Code XML Sample Request Body

JSON Request Body Sample​

Download Defect Code JSON Sample Request Body

Response Description​

NameTypeDescription
ZcnWtClaimLookupEw20Response.ToutDefectObjectDefect
ZcnWtClaimLookupEw20Response.ToutDefect.Item.CodeStringDefect Code
ZcnWtClaimLookupEw20Response.ToutDefect.Item.DescriptionStringDefect Description
ZcnWtClaimLookupEw20Response.ToutFailureObjectFailure
ZcnWtClaimLookupEw20Response.ToutFailure.Item.CodeStringFailure Code
ZcnWtClaimLookupEw20Response.ToutFailure.Item.DescriptionStringFailure Description
ZcnWtClaimLookupEw20Response.ToutMaterialObjectMaterial
ZcnWtClaimLookupEw20Response.ToutMaterial.Item.MatCodeStringMaterial Code
ZcnWtClaimLookupEw20Response.ToutMaterial.Item.MaterialDescriptionStringMaterial Description
ZcnWtClaimLookupEw20Response.ToutOperationObjectOperation
ZcnWtClaimLookupEw20Response.ToutOperation.Item.MatCodeStringFailure Code
ZcnWtClaimLookupEw20Response.ToutOperation.Item.MaterialDescriptionStringFailure Description

XML Response Sample​

Download Defect Failure XML Response Sample

JSON Response Sample​

Download Defect Failure JSON Response Sample

Response Codes​

Status CodeMessage
200Claim Processing Completed.
4001. Required request body missing error!
2. Invalid Content-Type / format
3. Invalid json format in the request body!
4. Invalid json format in the request body!
5. E Please Check - User Is Not Setup as Active in Customer_CS table
6. E Dealer does not have sales area for this product.
7. E Invalid Vehicle Hours {Submitted Vehicle Hours}, not coherent with mean point hours {valid Hours}
500Internal Server Error
401Access denied due to invalid credentials!